home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / ma_103.zip / MA.HLP < prev    next >
Text File  |  1991-12-10  |  13KB  |  326 lines

  1. Message Alert v1.02
  2.  
  3. What is Message Alert?
  4. ----------------------
  5. Message Alert (MA) is a message base utility program that 
  6. tells you when any messages containing key phrases are 
  7. received on your system.  MA alerts you to these messages 
  8. by creating its own message in your netmail message area.  
  9. The easiest way to explain MA is to present an example.
  10.  
  11. Let's say you are running FrontDoor in a private network 
  12. that exchanges 14 echo areas in addition to Netmail.  You 
  13. don't need to read all of the messages every day yet you do 
  14. have to at least scan every folder (message area) daily 
  15. looking for certain key messages of interest.  This is 
  16. where MA comes in.
  17.  
  18. You can set up MA to watch specific folders (or ALL 
  19. folders) for any incoming messages that contain key 
  20. phrases.  You further tell MA where in the messages to 
  21. search for each search phrase.  You could set up one search 
  22. phrase in NetMail to search for any message where the 
  23. sender's name contains the phrase "McDaniel." You could set 
  24. up a search with a phrase of "modems" and have MA search 
  25. only the subject lines of messages in the folder FD_DEV.
  26.  
  27. Simply put, MA alerts you to any incoming messages from a 
  28. person, to a person, about a subject, or containing a 
  29. phrase in the body of the text.
  30.  
  31. MA and FrontDoor
  32. ----------------
  33. In order for MA to work, you must be using FrontDoor and 
  34. MUST have all of your message folders set up as Folders in 
  35. FDSETUP.
  36.  
  37. If you are running FrontDoor and a bulletin board system 
  38. using the Hudson style message format, you must still have 
  39. every message area set up as a folder in FOLDER.FD.
  40.  
  41. MA requires that you are running FrontDoor and that your   
  42. FD config file be in the 2.02 format.  In other words, your 
  43. FD configuration file must be named SETUP.FD.  Older 
  44. versions of FD called the cfg file FD.SYS and it is safe to 
  45. copy FD.SYS as SETUP.FD in the FD directory.  MA will NOT 
  46. run properly if you are not using FrontDoor or if the 
  47. SETUP.FD file is not found.
  48.  
  49. You do not have to run MA from the FD directory; however, 
  50. you must run MA from the directory where the MA.EXE file is 
  51. located.
  52.  
  53. MA and Message Bases Formats
  54. ----------------------------
  55. MA currently works on two types of message bases:
  56.       1) The Opus/FD style using .MSG files.
  57.       2) The Hudson format used by QuickBBS and support by  
  58.          certain versions of TosScan/FD.
  59.       -) There are plans to support the TPBoard message      
  60.          base as well.
  61.  
  62. The Opus format requires no additional setup when using MA.
  63.  
  64. The Hudson message format does require special instruction.  
  65. If you are using the Hudson format with TosScan (no 
  66. bulletin board), you must establish a User named "MA MA" in 
  67. FDSetup (without the quotes).  Users are edited under the 
  68. menu option GLOBAL.
  69.  
  70. If you are using the Hudson format with a bulletin board, 
  71. you must add a user to your USERS.BBS file.   The earlier 
  72. in your USERS file that you add "MA MA," the faster will be 
  73. MA's search for that record. This provides MA with access 
  74. to the LastRead record used by MA to record scanned 
  75. messages.
  76.  
  77. Setting up MA
  78. -------------
  79. MA requires very little configuration.  Run MA from the DOS 
  80. prompt and you will see a pull-down menu with the following 
  81. main-bar options:  Configs   Scan   Locks   Exit
  82.  
  83. Move the highlight bar to Configs and press [Enter].  You 
  84. now have two choices:  Searches and Options; select 
  85. Options.
  86.  
  87. The settings you see are the only settings required for MA  
  88. other than the message Search criteria records.  For full  
  89. help on what these settings do, move the highlight bar to  
  90. any setting and press [F1].   But briefly:
  91.  
  92.     Editor:  When you run a scan of messages from the   
  93.              pull-down menu, a file is created with a  
  94.              report of the results. To view this file, MA  
  95.              calls the editor you specify here.
  96.     Color:   A Yes or No setting to turn color on/off in  
  97.              MA.
  98.     Lock:    When messages are found that match a search  
  99.              record, you have the option of "locking" to  
  100.              prevent them from being deleted.  Make very  
  101.              sure that you aren't running any other  
  102.              utilities that will have problems with locked
  103.              .MSG files.
  104.     Style:   Which style of message base are you using.  If  
  105.              you select Hudson and don't have the necessary  
  106.              support files available, you won't be able to  
  107.              reenter MA without deleting the MA.CFG file.    
  108.     Users:   If you are running a Hudson format message   
  109.              base with a bulletin board, this sets the DOS  
  110.              path to your Users.bbs file.
  111.  
  112. To save these settings after editing, select the SAVE 
  113. option from the Exit menu.
  114.  
  115. Search records
  116. --------------
  117. These records specify the criteria for MA's scans through 
  118. the message base.  A search record consists of:
  119.  
  120.     -   a phrase to search for
  121.     -   instructions on which part of the message to search
  122.     -   the folder in which to search
  123.     -   instructions on deleting matching records
  124.     -   any special instructions according to the type of  
  125.         search
  126.  
  127. To edit/create search records, select SEARCH from the 
  128. Configs menu. The screen you will see appears something 
  129. like:
  130.  
  131.     Folder:  _____________
  132.     Phrase:  _____________
  133.     Search:  _____________
  134.     Flags:   _____________
  135.     Delete:  _____________
  136.  
  137. Initially, the Folder selected will be the first folder in 
  138. your FOLDER file.  If you have created any search records 
  139. for this folder, you will see the data for the first search 
  140. record for that folder.  If the phrase is blank (empty), 
  141. there are NO search records for this folder and you are 
  142. looking at a new search record which will only be saved 
  143. when or if completed.
  144.  
  145. Try pressing [ENTER] while the highlight bar is on FOLDER;   
  146. you will see a list of all the available folders.  By 
  147. selecting any of them, you will change to the list of 
  148. search records for the selected folder.   Once you select a 
  149. folder, all operations such as adding and deleting are for 
  150. THAT folder until you select a different folder.
  151.  
  152. SEARCH tells MA which part of the message you wish to scan.
  153. The options are:
  154.  
  155.     1)  The text of the message
  156.     2)  The subject line of the message
  157.     3)  The names of the message (both FROM and TO)
  158.  
  159. If you want to watch for the same phrase in both the 
  160. subject and text of the message, you will need to create 
  161. two search records for that folder with each having the 
  162. same search phrase.
  163.  
  164. PHRASE is the phrase you wish to have MA watch for.  There  
  165. are several considerations depending on which SEARCH type   
  166. you select.  If you are searching in either the text of the 
  167. message or the subject line, the message will be considered 
  168. a "match" and you will be alerted to that message *IF* the  
  169. phrase you enter is present ANYWHERE within the subject (or 
  170. text) or the message.  The search is case insensitive.
  171.  
  172. When searching in the subject line or message text, you can 
  173. further specify TWO search phrases which MUST appear 
  174. together in the same message subject line (or together in 
  175. the message text) to be considered a matching message.  To 
  176. enter two search phrases in the same search record, 
  177. separate them with two forward slash letters.   Example:   
  178. colour//red as a text search would look for COLOUR and RED 
  179. together in a message.
  180.  
  181. If you are searching the NAME fields of a message, you have 
  182. three additional commands to use.
  183.  
  184.     1)  If you enter a phrase that begins with an  
  185.         exclamation point, MA will search for any names  
  186.         that BEGIN with the following text.   For example:  
  187.         !MI would consider matching any names beginning  
  188.         with MI.
  189.     2)  If you enter a phrase that begins with an @ mark,  
  190.         MA will search for any names that contains the
  191.         following text.   For example:   @MI would consider
  192.         matching any names that contain MI
  193.     3)  If you don't use any of the above two command, MA  
  194.         will expect an exact match.  If you enter "John  
  195.         Henry", MA will only consider a match the full name  
  196.         "John Henry".
  197.  
  198. FLAGS.  Currently, only the name SEARCH types support any   
  199. additional flags.  When searching the name fields, you must 
  200. tell MA which name field to search:  the FROM name, the TO 
  201. name, or BOTH names.
  202.  
  203. DELETE.  When searching the name fields, you have the 
  204. additional option of deleting any matching messages.  This 
  205. option only works in the OPUS style message base.  You 
  206. would use this option when you absolutely didn't  want any 
  207. messages entering your system from a particular source 
  208. (person).
  209.  
  210. Adding records
  211. --------------
  212. Search records are added by pressing [INS]. You will see a 
  213. new record appear with a blank phrase field. You can add as 
  214. many records as you wish; however, only complete records 
  215. are saved on exiting MA.
  216.  
  217. Deleting records
  218. ----------------
  219. Search records are deleted by pressing [DEL].  If the 
  220. record phrase is blank and there are no records remaining 
  221. for the current folder, there is no harming is pressing the 
  222. [DEL] key.
  223.  
  224. SCANNING
  225. --------
  226. The process of having MA search through new messages is 
  227. called a "scan."  If you have added new search records and 
  228. want MA to look through messages it has already looked 
  229. through, that is called a "rescan."  Both of these are 
  230. options from the SCAN selection on the main menu bar.  You 
  231. can scan or rescan from the menu but MA was really intended 
  232. to run from a batch file following new incoming mail.  In 
  233. this way, MA performs the searching whenever mail arrives 
  234. without your instruction every time.
  235.  
  236. To run a scan without entering MA, type MA at the DOS 
  237. prompt followed by any mix of the following options:
  238.  
  239.     /?  = displays this help list
  240.     /S  = instructions to perform a scan
  241.     /M  = instructions to output a netmail message report
  242.     /F  = forces a rescan of previously scanned messages
  243.     /L  = turns off locking regardless of MA's settings
  244.     /Q  = runs MA in quick mode
  245.  
  246. /S Scan
  247. This option is required to initiate  a scan from the DOS 
  248. prompt. Without this option, MA will load in full screen 
  249. mode regardless of any other option (other than /?).
  250.  
  251. /M  MESSAGE
  252. This tells MA to produce a .MSG file in your netmail area 
  253. with a report on the findings of this scan.  If you don't 
  254. use /M, you will have to check for the report file 
  255. MASCAN.OUT.
  256.  
  257. /F  FORCE RESCAN
  258. Use with -- not to replace -- the /S option, this tells MA 
  259. to extend the scan to already scanned messages.  MA knows 
  260. which messages have been scanned by either the lastread 
  261. counters (in the Hudson format) or a flag set in the 
  262. message itself (OPUS style base).
  263.  
  264. /L  LOCK Override
  265. Overrides the internal "lock" settings and disables message 
  266. locking.
  267.  
  268. /Q  Quickmode
  269. Normally, MA scans by folder and takes the search records 
  270. in sequence. This means that for EACH search record, ALL   
  271. messages must be read in.  This is done to produce a report 
  272. like the following:
  273.  
  274.     SYS18
  275.     -----
  276.  
  277.     COSTS   Text search
  278.             Msg# 1   JAMES SMITH        ANTHONY LISA ET AL
  279.             Msg# 10  JAMES SMITH        JOHN NELSON
  280.  
  281.     TEST    Text search
  282.             Msg# 2   JAMES SMITH        NO ONE
  283.  
  284.     COLOUR//RED   Text search
  285.             Msg# 1   John Brown         GRAPHICS
  286.  
  287. Note that all findings (see the COSTS text search) for a 
  288. particular search are grouped together.  To do this, the 
  289. same messages had to be read for scan for each of the 
  290. subsequent searches.
  291.  
  292. QUICK mode changes that to open each message once and then 
  293. for that message, run through all the searches:
  294.  
  295.  
  296.     SYS18
  297.     -----
  298.  
  299.     MSG# 1
  300.  
  301.       COSTS   Text search
  302.               JAMES SMITH               ANTHONY LISA ET AL
  303.  
  304.     MSG# 10
  305.       COSTS   Text search
  306.               JAMES SMITH               JOHN NELSON
  307.  
  308.     MSG# 2
  309.        TEST   Text search
  310.               John Brown                Graphics
  311.  
  312. This saves a marginal amount of time because MA only opens 
  313. each message once.  The savings are about 20-25% but the 
  314. primary factor is the difference in the format of the 
  315. reports.  Do you want all matches for a message to be 
  316. grouped together?  Or would your prefer all findings for a 
  317. search to list the matched messages?
  318.  
  319. Locking/Unlocking
  320. -----------------
  321. Message locking and unlocking is only performed on the OPUS 
  322. .MSG style message base.  If you are running a bulletin   
  323. board that imports from the OPUS format, you should ensure  
  324. that you importer can import READ-ONLY message files before 
  325. enabling locking.
  326.